﻿/*
Copyright (c) 2013, Marc Tanti
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the www.marctanti.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using MARIA.level.robot;
using MARIA.program.statementfactory;
using System.Runtime.Serialization;

namespace MARIA.program.statement
{
    /// <summary>
    /// A tree node which represents a program statement.
    /// </summary>
    public abstract class Statement : TreeNode
    {

        /// <summary>
        /// Initializes a new instance of Statement.
        /// </summary>
        public Statement()
        {
        }

        public Statement(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
        }
        protected override void Serialize(SerializationInfo si, StreamingContext context)
        {
            base.Serialize(si, context);
        }

        /// <summary>
        /// Get the factory object which creates this statement.
        /// </summary>
        /// <returns>The factory object.</returns>
        public abstract StatementFactory GetFactory();

        /// <summary>
        /// Returns whether or not this statement can accept another statement as its child.
        /// </summary>
        /// <param name="child">The child-to-be statment.</param>
        /// <returns>Whether it can be accepted or not.</returns>
        public abstract bool CanAdd(Statement child);

        /// <summary>
        /// Returns whether or not this statement can allow the removal of a particular child statement.
        /// </summary>
        /// <param name="child">The child statement to remove.</param>
        /// <returns>Whether it can be removed or not.</returns>
        public abstract bool CanRemove(Statement child);

        /// <summary>
        /// Execute the statement.
        /// </summary>
        /// <param name="robot">The robot to manipulate.</param>
        /// <param name="statementStack">The stack of statements to be executed following this one (to control program flow).</param>
        public abstract void Execute(Robot robot, Stack<Statement> statementStack);

        /// <summary>
        /// Set the editor panel to edit this statement.
        /// </summary>
        /// <param name="p">The editor panel.</param>
        public abstract void SetEditPanel(Panel p);

    }
}
